/*
 * Copyright (C) 2008 The Android Open Source Project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/**
 * @defgroup stat Stat
 * @ingroup libc
 */

#ifndef _SYS_STAT_H_
#define _SYS_STAT_H_

#include <bits/timespec.h>
#ifndef __LITEOS__
#include <linux/stat.h>
#else
#include <liteos/stat.h>
#endif
#include <sys/cdefs.h>
#include <sys/types.h>

#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */


#if defined(__aarch64__) || (defined(__mips__) && defined(__LP64__))
#define __STAT64_BODY \
  dev_t st_dev; \
  ino_t st_ino; \
  mode_t st_mode; \
  nlink_t st_nlink; \
  uid_t st_uid; \
  gid_t st_gid; \
  dev_t st_rdev; \
  unsigned long __pad1; \
  off_t st_size; \
  int st_blksize; \
  int __pad2; \
  long st_blocks; \
  struct timespec st_atim; \
  struct timespec st_mtim; \
  struct timespec st_ctim; \
  unsigned int __unused4; \
  unsigned int __unused5; \

#elif defined(__mips__) && !defined(__LP64__)
#define __STAT64_BODY \
  unsigned int st_dev; \
  unsigned int __pad0[3]; \
  unsigned long long st_ino; \
  mode_t st_mode; \
  nlink_t st_nlink; \
  uid_t st_uid; \
  gid_t st_gid; \
  unsigned int st_rdev; \
  unsigned int __pad1[3]; \
  long long st_size; \
  struct timespec st_atim; \
  struct timespec st_mtim; \
  struct timespec st_ctim; \
  unsigned int st_blksize; \
  unsigned int __pad2; \
  unsigned long long st_blocks; \

#elif defined(__x86_64__)
#define __STAT64_BODY \
  dev_t st_dev; \
  ino_t st_ino; \
  unsigned long st_nlink; \
  mode_t st_mode; \
  uid_t st_uid; \
  gid_t st_gid; \
  unsigned int __pad0; \
  dev_t st_rdev; \
  off_t st_size; \
  long st_blksize; \
  long st_blocks; \
  struct timespec st_atim; \
  struct timespec st_mtim; \
  struct timespec st_ctim; \
  long __pad3[3]; \

#else /* __arm__ || __i386__ */
#define __STAT64_BODY \
  unsigned long long st_dev; \
  unsigned char __pad0[4]; \
  unsigned long __st_ino; \
  unsigned int st_mode; \
  nlink_t st_nlink; \
  uid_t st_uid; \
  gid_t st_gid; \
  unsigned long long st_rdev; \
  unsigned char __pad3[4]; \
  long long st_size; \
  unsigned long st_blksize; \
  unsigned long long st_blocks; \
  struct timespec st_atim; \
  struct timespec st_mtim; \
  struct timespec st_ctim; \
  unsigned long long st_ino; \

#endif

struct stat { __STAT64_BODY };
struct stat64 { __STAT64_BODY };

#undef __STAT64_BODY

/* Compatibility with older versions of POSIX. */
#define st_atime st_atim.tv_sec
#define st_mtime st_mtim.tv_sec
#define st_ctime st_ctim.tv_sec
/* Compatibility with glibc. */
#define st_atimensec st_atim.tv_nsec
#define st_mtimensec st_mtim.tv_nsec
#define st_ctimensec st_ctim.tv_nsec

#ifdef __USE_BSD
/* Permission macros provided by glibc for compatibility with BSDs. */
#define ACCESSPERMS (S_IRWXU | S_IRWXG | S_IRWXO) /* 0777 */
#define ALLPERMS    (S_ISUID | S_ISGID | S_ISVTX | S_IRWXU | S_IRWXG | S_IRWXO) /* 07777 */
#define DEFFILEMODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH) /* 0666 */
#endif

extern int chmod(const char*, mode_t);
extern int fchmod(int, mode_t);

/**
* @ingroup stat
*
* @par Description:
* The mkdir() function shall create a new directory with name path. The file permission bits of the new directory shall
* be initialized from mode. These file permission bits of the mode argument shall be modified by the process' file
* creation mask.
* @param pathname [IN] Directory with name path.
* @param mode     [IN] File permission bits.
* @attention
* <ul>
* <li>None.</li>
* </ul>
*
* @retval #0  Upon successful completion.
* @retval #-1 Failed and set errno to indicate the error.
*
* @par Errors
* <ul>
* <li><b>EINVAL</b>: The len argument or the offset argument is less than zero or greater than INT_MAX,
* or extend size is not equal to FALLOC_FL_KEEP_SIZE.</li>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor or or the underlying file system does not support
* this operation.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EACCES</b>: Permission bits of the file mode do not permit the requested access,
* or search permission is denied on a component of the path prefix.</li>
* <li><b>ENAMETOOLONG</b>: The length of a component of a pathname is longer than {NAME_MAX}.</li>
* <li><b>ENOENT</b>: A directory component in pathname does not exist or  or path is an empty string or
* is a dangling symbolic link.</li>
* <li><b>EEXIST</b>: The file/directory object is already exist.</li>
* <li><b>EIO</b>: An I/O error occurred while reading from or writing to a file system.</li>
* <li><b>EROFS</b>: The physical drive is write protected.</li>
* <li><b>ENOSPC</b>: No space left on device.</li>
* <li><b>ENFILE</b>: The maximum allowable number of files is currently open in the system.</li>
* <li><b>ENOTEMPTY</b>: directory not empty.</li>
* <li><b>EISDIR</b>: The named file is a directory.</li>
* <li><b>ENOTDIR</b>: A component of the path prefix names an existing file that is neither a directory nor a symbolic
* link to a directory; or the path argument resolves to a non-directory file.</li>
* <li><b>EPERM</b>: Operation not permitted or access denied due to prohibited access or directory full.</li>
* <li><b>EBUSY</b>: The operation is rejected according to the file sharing policy.</li>
* <li><b>ENOSYS</b>: Not support.</li>
* <li><b>EPROTO</b>: Protocol error in nfs.</li>
* <li><b>EFAULT</b>: Bad address.</li>
* </ul>
*
* @par Dependency:
* <ul><li>stat.h</li></ul>
* @see None
* @since Huawei LiteOS V100R001C00
*/
extern int mkdir(const char* pathname, mode_t mode);

/**
* @ingroup stat
*
* @par Description:
* The fstat() function shall obtain information about an open file associated with the file descriptor fildes, and shall
* write it to the area pointed to by buf.
* @param fildes [IN] File descriptor fildes.
* @param buf    [IN] File stat.
* @attention
* <ul>
* <li>None.</li>
* </ul>
*
* @retval #0  Upon successful completion.
* @retval #-1 Failed and set errno to indicate the error.
*
* @par Errors
* <ul>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EINVAL</b>: Invalid argument.</li>
* <li><b>ENOENT</b>: a directory component in pathname does not exist or path is an empty string.</li>
* <li><b>ENAMETOOLONG</b>: The length of a component of a pathname is longer than {NAME_MAX}.</li>
* <li><b>ENOMEM</b>: Out of memory.</li>
* <li><b>ENOSYS</b>: no support.</li>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor or or the underlying file system does not support
* this operation.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EACCES</b>: Permission bits of the file mode do not permit the requested access,
* or search permission is denied on a component of the path prefix.</li>
* <li><b>EEXIST</b>: The file/directory object is already exist.</li>
* <li><b>EIO</b>: An I/O error occurred while reading from or writing to a file system.</li>
* <li><b>EROFS</b>: The physical drive is write protected.</li>
* <li><b>ENOSPC</b>: No space left on device.</li>
* <li><b>ENFILE</b>: The maximum allowable number of files is currently open in the system.</li>
* <li><b>ENOTEMPTY</b>: directory not empty.</li>
* <li><b>EISDIR</b>: The named file is a directory.</li>
* <li><b>ENOTDIR</b>: A component of the path prefix names an existing file that is neither a directory nor a symbolic
* link to a directory; or the path argument resolves to a non-directory file.</li>
* <li><b>EPERM</b>: operation not permitted or access denied due to prohibited access or directory full.</li>
* <li><b>EBUSY</b>: The operation is rejected according to the file sharing policy.</li>
* <li><b>ENOSYS</b>: not support.</li>
* <li><b>EPROTO</b>: Protocol error in nfs.</li>
* <li><b>ENODEV</b>: No such device.</li>
* <li><b>EFAULT</b>: Bad address.</li>
* </ul>
*
* @par Dependency:
* <ul><li>stat.h</li></ul>
* @see None
* @since Huawei LiteOS V100R001C00
*/
extern int fstat(int fildes, struct stat* buf);

/**
* @ingroup stat
*
* @par Description:
* The fstat64() function shall obtain information about an open file associated with the file descriptor fildes,
* and shall write it to the area pointed to by buf.
* @param fildes [IN] File descriptor fildes.
* @param buf    [IN] File stat.
* @attention
* <ul>
* <li>None.</li>
* </ul>
*
* @retval #0  Upon successful completion.
* @retval #-1 Failed and set errno to indicate the error.
*
* @par Errors
* <ul>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EINVAL</b>: Invalid argument.</li>
* <li><b>ENOENT</b>: A directory component in pathname does not exist or path is an empty string.</li>
* <li><b>ENAMETOOLONG</b>: The length of a component of a pathname is longer than {NAME_MAX}.</li>
* <li><b>ENOMEM</b>: Out of memory.</li>
* <li><b>ENOSYS</b>: No support.</li>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor or or the underlying file system does not support
* this operation.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EACCES</b>: Permission bits of the file mode do not permit the requested access,
* or search permission is denied on a component of the path prefix.</li>
* <li><b>EEXIST</b>: The file/directory object is already exist.</li>
* <li><b>EIO</b>: An I/O error occurred while reading from or writing to a file system.</li>
* <li><b>EROFS</b>: The physical drive is write protected.</li>
* <li><b>ENOSPC</b>: No space left on device.</li>
* <li><b>ENFILE</b>: The maximum allowable number of files is currently open in the system.</li>
* <li><b>ENOTEMPTY</b>: directory not empty.</li>
* <li><b>EISDIR</b>: The named file is a directory.</li>
* <li><b>ENOTDIR</b>: A component of the path prefix names an existing file that is neither a directory nor a symbolic
* link to a directory; or the path argument resolves to a non-directory file.</li>
* <li><b>EPERM</b>: Operation not permitted or access denied due to prohibited access or directory full.</li>
* <li><b>EBUSY</b>: The operation is rejected according to the file sharing policy.</li>
* <li><b>ENOSYS</b>: Not support.</li>
* <li><b>EPROTO</b>: Protocol error in nfs.</li>
* <li><b>ENODEV</b>: No such device.</li>
* <li><b>EFAULT</b>: Bad address.</li>
* </ul>
*
* @par Dependency:
* <ul><li>stat.h</li></ul>
* @see None
* @since Huawei LiteOS V100R001C00
*/
extern int fstat64(int fildes, struct stat64* buf);
extern int fstatat(int, const char*, struct stat*, int);
extern int fstatat64(int, const char*, struct stat64*, int);

/**
* @ingroup stat
*
* @par Description:
* The lstat() function shall be equivalent to stat(), function shall obtain information about the named file and write
* it to the area pointed to by the buf.
* argument.
* @param path   [IN] Points to a pathname naming a file.
* @param buffer [IN] File stat.
* @attention
* <ul>
* <li>None.</li>
* </ul>
*
* @retval #0  Upon successful completion.
* @retval #-1 Failed and set errno to indicate the error.
*
* @par Errors
* <ul>
* <li><b>EINVAL</b>: Invalid argument.</li>
* <li><b>ENOENT</b>: A directory component in pathname does not exist or path is an empty string.</li>
* <li><b>ENAMETOOLONG</b>: The length of a component of a pathname is longer than {NAME_MAX}.</li>
* <li><b>ENOMEM</b>: Out of memory.</li>
* <li><b>ENOSYS</b>: No support.</li>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor or or the underlying file system does not support
* this operation.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EACCES</b>: Permission bits of the file mode do not permit the requested access,
* or search permission is denied on a component of the path prefix.</li>
* <li><b>EEXIST</b>: The file/directory object is already exist.</li>
* <li><b>EIO</b>: An I/O error occurred while reading from or writing to a file system.</li>
* <li><b>EROFS</b>: The physical drive is write protected.</li>
* <li><b>ENOSPC</b>: No space left on device.</li>
* <li><b>ENFILE</b>: The maximum allowable number of files is currently open in the system.</li>
* <li><b>ENOTEMPTY</b>: directory not empty.</li>
* <li><b>EISDIR</b>: The named file is a directory.</li>
* <li><b>ENOTDIR</b>: A component of the path prefix names an existing file that is neither a directory nor a symbolic
* link to a directory; or the path argument resolves to a non-directory file.</li>
* <li><b>EPERM</b>: Operation not permitted or access denied due to prohibited access or directory full.</li>
* <li><b>EBUSY</b>: The operation is rejected according to the file sharing policy.</li>
* <li><b>ENOSYS</b>: Not support.</li>
* <li><b>EPROTO</b>: Protocol error in nfs.</li>
* <li><b>ENODEV</b>: No such device.</li>
* <li><b>EFAULT</b>: Bad address.</li>
* </ul>
*
* @par Dependency:
* <ul><li>stat.h</li></ul>
* @see None
* @since Huawei LiteOS V100R001C00
*/
extern int lstat(const char* path, struct stat* buffer);
extern int lstat64(const char*, struct stat64*);

/**
* @ingroup stat
*
* @par Description:
* The stat() function shall obtain information about the named file and write it to the area pointed to by the buf
* argument.
* @param path  [IN] Points to a pathname naming a file.
* @param buf   [IN] File stat.
* @attention
* <ul>
* <li>None.</li>
* </ul>
*
* @retval #0  Upon successful completion.
* @retval #-1 Failed and set errno to indicate the error.
*
* @par Errors
* <ul>
* <li><b>EINVAL</b>: Invalid argument.</li>
* <li><b>ENOENT</b>: A directory component in pathname does not exist or path is an empty string.</li>
* <li><b>ENAMETOOLONG</b>: The length of a component of a pathname is longer than {NAME_MAX}.</li>
* <li><b>ENOMEM</b>: Out of memory.</li>
* <li><b>ENOSYS</b>: No support.</li>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor or or the underlying file system does not support
* this operation.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EACCES</b>: Permission bits of the file mode do not permit the requested access,
* or search permission is denied on a component of the path prefix.</li>
* <li><b>EEXIST</b>: The file/directory object is already exist.</li>
* <li><b>EIO</b>: An I/O error occurred while reading from or writing to a file system.</li>
* <li><b>EROFS</b>: The physical drive is write protected.</li>
* <li><b>ENOSPC</b>: No space left on device.</li>
* <li><b>ENFILE</b>: The maximum allowable number of files is currently open in the system.</li>
* <li><b>ENOTEMPTY</b>: directory not empty.</li>
* <li><b>EISDIR</b>: The named file is a directory.</li>
* <li><b>ENOTDIR</b>: A component of the path prefix names an existing file that is neither a directory nor a symbolic
* link to a directory; or the path argument resolves to a non-directory file.</li>
* <li><b>EPERM</b>: Operation not permitted or access denied due to prohibited access or directory full.</li>
* <li><b>EBUSY</b>: The operation is rejected according to the file sharing policy.</li>
* <li><b>ENOSYS</b>: Not support.</li>
* <li><b>EPROTO</b>: Protocol error in nfs.</li>
* <li><b>ENODEV</b>: No such device.</li>
* <li><b>EFAULT</b>: Bad address.</li>
* </ul>
*
* @par Dependency:
* <ul><li>stat.h</li></ul>
* @see None
* @since Huawei LiteOS V100R001C00
*/
extern int stat(const char* path, struct stat* buf);

/**
* @ingroup stat
*
* @par Description:
* The stat64() function shall obtain information about the named file and write it to the area pointed to by the buf
* argument.
* @param path  [IN] Points to a pathname naming a file.
* @param buf   [IN] File stat.
* @attention
* <ul>
* <li>None.</li>
* </ul>
*
* @retval #0  Upon successful completion.
* @retval #-1 Failed and set errno to indicate the error.
*
* @par Errors
* <ul>
* <li><b>EINVAL</b>: Invalid argument.</li>
* <li><b>ENOENT</b>: A directory component in pathname does not exist or path is an empty string.</li>
* <li><b>ENAMETOOLONG</b>: The length of a component of a pathname is longer than {NAME_MAX}.</li>
* <li><b>ENOMEM</b>: Out of memory.</li>
* <li><b>ENOSYS</b>: No support.</li>
* <li><b>EBADF</b>: The fd argument is not a valid file descriptor or or the underlying file system does not support
* this operation.</li>
* <li><b>EAGAIN</b>: The file list is NULL.</li>
* <li><b>EACCES</b>: Permission bits of the file mode do not permit the requested access,
* or search permission is denied on a component of the path prefix.</li>
* <li><b>EEXIST</b>: The file/directory object is already exist.</li>
* <li><b>EIO</b>: An I/O error occurred while reading from or writing to a file system.</li>
* <li><b>EROFS</b>: The physical drive is write protected.</li>
* <li><b>ENOSPC</b>: No space left on device.</li>
* <li><b>ENFILE</b>: The maximum allowable number of files is currently open in the system.</li>
* <li><b>ENOTEMPTY</b>: directory not empty.</li>
* <li><b>EISDIR</b>: The named file is a directory.</li>
* <li><b>ENOTDIR</b>: A component of the path prefix names an existing file that is neither a directory nor a symbolic
* link to a directory; or the path argument resolves to a non-directory file.</li>
* <li><b>EPERM</b>: Operation not permitted or access denied due to prohibited access or directory full.</li>
* <li><b>EBUSY</b>: The operation is rejected according to the file sharing policy.</li>
* <li><b>ENOSYS</b>: Not support.</li>
* <li><b>EPROTO</b>: Protocol error in nfs.</li>
* <li><b>ENODEV</b>: No such device.</li>
* <li><b>EFAULT</b>: Bad address.</li>
* </ul>
*
* @par Dependency:
* <ul><li>stat.h</li></ul>
* @see None
* @since Huawei LiteOS V100R001C00
*/
extern int stat64(const char* path, struct stat64* buf);

extern int mknod(const char*, mode_t, dev_t);
extern mode_t umask(mode_t);

extern mode_t __umask_chk(mode_t);
extern mode_t __umask_real(mode_t) __RENAME(umask);
__errordecl(__umask_invalid_mode, "umask called with invalid mode");

#if defined(__BIONIC_FORTIFY)

__BIONIC_FORTIFY_INLINE
mode_t umask(mode_t mode) {
#if !defined(__clang__)
  if (__builtin_constant_p(mode)) {
    if ((mode & 0777) != mode) {
      __umask_invalid_mode();
    }
    return __umask_real(mode);
  }
#endif
  return __umask_chk(mode);
}
#endif /* defined(__BIONIC_FORTIFY) */

extern int mkfifo(const char*, mode_t) __INTRODUCED_IN(21);
extern int mkfifoat(int, const char*, mode_t);

extern int fchmodat(int, const char*, mode_t, int);
extern int mkdirat(int, const char*, mode_t);
extern int mknodat(int, const char*, mode_t, dev_t);

#define UTIME_NOW  ((1L << 30) - 1L)
#define UTIME_OMIT ((1L << 30) - 2L)
extern int utimensat(int fd, const char *path, const struct timespec times[2], int flags);
extern int futimens(int fd, const struct timespec times[2]);

#ifndef __LITEOS__
#if __ANDROID_API__ < 21
#include <android/legacy_sys_stat_inlines.h>
#endif
#endif


#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */

#endif /* _SYS_STAT_H_ */
